/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.platformservice.persistence.api;

import java.io.File;
import java.io.IOException;

public interface IPackagingVisitor
{
    int DIRECTION_IN = 0;
    int DIRECTION_OUT = 1;

    /**
     * Visitation method that is always invoked first, and must always be paired with a matching {@link #endVisit()}
     * call in order to ensure all resources are released.
     *
     * @param packageFile Existing package file to import
     * @throws java.io.IOException When the package file cannot be processed
     */
    void startVisit(File packageFile) throws IOException;

    void visitMessageBeanManager(IMessageBeanManager messageBeanManager) throws IOException;

    void visitVFSManager(IVFSManager vfsManager) throws IOException;

    void visitProjectManager(IProjectManager projectManager) throws IOException;

    void endVisit() throws IOException;
}
